Package com.netscape.certsrv.logging
Class LogEventListener
java.lang.Object
com.netscape.certsrv.logging.LogEventListener
- All Implemented Interfaces:
EventListener
- Direct Known Subclasses:
LogFile
A class representing a log event listener.
A LogEventListener is registered to a specific
ILogQueue to be notified of created ILogEvents.
the log queue will notify all its registered listeners
of the logged event. The listener will then proceed to
process the event accordingly which will result in a log
message existing in some file.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
flush()
Flushes the log buffers (if any).abstract ConfigStore
Get the configuration store for the log event listener.Return list of default config parameters for this log event listener.abstract String
Returns the description of this log event listener.abstract String
Returns implementation name.Return list of instance config parameters for this log event listener.abstract void
init
(Subsystem owner, LoggerConfig config) Initialize this log listenerabstract void
The event notification method: Logs event.abstract NameValuePairs
Retrieve last "maxLine" number of system logs with log level > "level" and from source "source".abstract NameValuePairs
retrieveLogList
(Hashtable<String, String> req) Retrieve list of log files.void
setCMSEngine
(CMSEngine engine) abstract void
shutdown()
Closes the log file and destroys any associated threads.abstract void
startup()
Startup the instance.
-
Field Details
-
engine
-
-
Constructor Details
-
LogEventListener
public LogEventListener()
-
-
Method Details
-
getCMSEngine
-
setCMSEngine
-
log
The event notification method: Logs event.- Parameters:
event
- The log event to be processed.- Throws:
ELogException
-
flush
public abstract void flush()Flushes the log buffers (if any). Will result in the messages being actually written to their destination. -
shutdown
public abstract void shutdown()Closes the log file and destroys any associated threads. -
getConfigStore
Get the configuration store for the log event listener.- Returns:
- The configuration store of this log event listener.
-
init
Initialize this log listener- Parameters:
owner
- The subsystem.config
- Configuration store for this log listener.
-
startup
Startup the instance.- Throws:
EBaseException
-
retrieveLogContent
public abstract NameValuePairs retrieveLogContent(Hashtable<String, String> req) throws javax.servlet.ServletException, IOException, EBaseExceptionRetrieve last "maxLine" number of system logs with log level > "level" and from source "source". If the parameter is omitted. All entries are sent back.- Parameters:
req
- a Hashtable containing the required information such as log entry, log level, log source, and log name.- Returns:
- NameValue pair list of log messages.
- Throws:
javax.servlet.ServletException
- For servlet errors.IOException
- For input/output problems.EBaseException
- For other problems.
-
retrieveLogList
public abstract NameValuePairs retrieveLogList(Hashtable<String, String> req) throws javax.servlet.ServletException, IOException, EBaseExceptionRetrieve list of log files.- Throws:
javax.servlet.ServletException
IOException
EBaseException
-
getImplName
Returns implementation name.- Returns:
- String name of event listener implementation.
-
getDescription
Returns the description of this log event listener.- Returns:
- String with listener description.
-
getDefaultParams
Return list of default config parameters for this log event listener.- Returns:
- Vector of default parameters.
-
getInstanceParams
Return list of instance config parameters for this log event listener.- Returns:
- Vector of instance parameters.
-